-
Notifications
You must be signed in to change notification settings - Fork 8
Clean up orphaned images and update asset management docs (contributing and readme) #860
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Delete 1,493 orphaned local image files (~355 MB) - Upload remaining 2 images to Cloudinary - Update CONTRIBUTING.md and README.md with Cloudinary workflow - All 255 assets now on Cloudinary at full quality
🌿 Documentation Preview
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR migrates the documentation's asset management strategy from Git-based storage to Cloudinary hosting, cleaning up legacy image files and updating contributor documentation accordingly.
Key Changes:
- Removed 1,493 orphaned image files (~355 MB) from the repository
- Established Cloudinary as the single source of truth for all documentation assets
- Updated contributor workflows in CONTRIBUTING.md and README.md to reflect the new asset hosting approach
Reviewed changes
Copilot reviewed 2 out of 1496 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Added high-level overview of Cloudinary-based asset workflow with quick-start instructions |
| CONTRIBUTING.md | Replaced local image storage guidance with comprehensive Cloudinary upload procedures, best practices, and video embed examples |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Codex Review
https://github.com/alchemyplatform/docs/blob/d17c3d19cedd67606dd83bd244ad4cc6253c141d/fern/tutorials/transactions/transaction-history/12f0f77-image_12.png#L1
Deleted assets still referenced in tutorials
This change removes the screenshot file 12f0f77-image_12.png (and similar assets like b6c4aaf-image_11.png), but the transaction-history tutorial still embeds those filenames via relative links, so viewing that page will now render broken images. Please rehost the screenshots (e.g., on Cloudinary) or update the MDX references before deleting the files.
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
NOTE: This is now fixed!!!
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
- Upload 64 previously missing images to Cloudinary - Update 29 MDX files with working Cloudinary URLs (72 total references) - Fix broken image paths that were causing Fern errors - All images now served from Cloudinary at full quality
- Upload remaining trace-api and webhooks images to Cloudinary - Update 3 MDX files with Cloudinary URLs - Fix last batch of Fern image measurement errors
- Add note that Cloudinary access is for internal Alchemy team only - Provide guidance for external contributors to request asset uploads - Update both CONTRIBUTING.md and README.md
pnpm run validate)